Skip to main content

signercli -config

Configuration Profile Management Command Reference​

1. Overview​

The signercli -config command is used to manage signing configuration profiles.

Profiles allow you to persist commonly used settings such as:

  • Server URL
  • Authentication credentials (API key, SSH key, username)
  • Certificate selection
  • Timestamp server configuration
  • Hash algorithm
  • Output format
  • Document signing appearance options

Using profiles simplifies:

  • Repeated signing operations
  • CI/CD automation
  • Multi-environment setups (e.g., default, staging, production)

2. Command Usage​

signercli -config
signercli -config list
signercli -config show <profile>
signercli -config set [profile] <options>
signercli -config unset [profile] <options>
signercli -config delete <profile>

3. Description​

The configuration system is profile-based.

Key behaviors:

  • If no profile name is specified, the default profile is used
  • All non-default profiles inherit settings from default
  • Settings defined in a profile override inherited values

This design enables:

  • Global defaults
  • Environment-specific overrides
  • Minimal duplication of configuration

4. Configuration File Location​

PlatformPath
Linux / macOS~/.signer/config
Windows%USERPROFILE%\.signer\config

The configuration file is stored locally and read automatically by signercli.

5. Viewing Configuration​

Show Entire Configuration File​

signercli -config

List Available Profiles​

signercli -config list

Show Profile Details​

signercli -config show production

Displays the effective configuration, including inherited values.

6. Creating or Updating Profiles (set)​

Command Syntax​

signercli -config set [profile] <options>

If profile is omitted, settings are applied to the default profile.

General Set Options​

OptionDescription
-host <url>Signer Server URL
-ssh-key-path <path>SSH private key path
-username <name>SSH username
-user <id>User ID (password authentication)
-api-key <key>API key (authentication without login)
-cert-id <id>Certificate ID
-cert-serial <serial>Certificate serial number
-expires <time>Token expiration (e.g., 24h, 7d)
-include-chainInclude certificate chain
-timestamp-url <url>Timestamp server URL
-hash-algorithm <alg>sha256, sha384, sha512
-output-format <type>Default output format

Output Format Options​

classic (default), json, table, csv

7. Document Signing Options (PDF)​

These options control visual appearance of document signatures.

OptionDescription
-doc-style <style>Signature style (watermark, box, barcode, qrcode)
-doc-position <pos>Position (bottom-right, top-left, center, etc.)
-doc-font-size <size>Font size
-doc-opacity <value>Opacity (0.0–1.0 or 0–100)

These settings are applied automatically when signing documents such as PDFs.

8. Examples​

Set Server URL and API Key (Default Profile)​

signercli -config set \
  -host https://signer.example.com:7443 \
  -api-key cdk_xxx

Create a Production Profile​

signercli -config set production \
  -host https://prod.example.com:7443 \
  -cert-id prod-cert-001 \
  -timestamp-url http://timestamp.digicert.com

List Profiles​

signercli -config list

Show Profile Details​

signercli -config show production

Remove Settings from a Profile (unset)​

signercli -config unset -api-key
signercli -config unset production -cert-id -timestamp-url

  • Removed values fall back to inherited settings (if any)

Delete a Profile​

signercli -config delete staging

9. Profile Inheritance Model​

  • default profile acts as the base configuration
  • Named profiles inherit all values from default
  • Explicitly set values override inherited values
  • Unset values revert to inherited defaults

This model enables clean separation between:

  • Global defaults
  • Environment-specific customization

10. Typical Use Cases​

  • Define global defaults in default
  • Create production, staging, ci profiles
  • Reference profiles in signing commands:
signercli myapp.exe -profile production

CommandDescription
signercli -loginAuthenticate and create session
signercli -signSign files using profile
signercli -verifyVerify signed files
signercli -cert idSet active certificate

12. Documentation Reference​

docs/CONFIG-FILE-GUIDE.md

This document provides a detailed explanation of the configuration file format and advanced usage.

13. Summary​

The signercli -config command provides structured, reusable configuration management, enabling:

  • Consistent signing behavior
  • Secure credential handling
  • Easy CI/CD integration
  • Multi-environment workflows

It is a foundational component of efficient and secure Signer CLI usage.